Deployment Tools Foundation
View Class
A View represents a result set obtained when processing a query using the
OpenView(String, array<Object>[]()[][]) method of a
Database. Before any data can be transferred,
the query must be executed using the Execute(Record) method, passing to
it all replaceable parameters designated within the SQL query string.
Declaration Syntax| C# | Visual Basic | Visual C++ | F# |
public class View : InstallerHandle, IEnumerable<Record>, IEnumerable
Public Class View Inherits InstallerHandle Implements IEnumerable(Of Record), IEnumerable
public ref class View : public InstallerHandle, IEnumerable<Record^>, IEnumerable
type View = class inherit InstallerHandle interface IEnumerable<Record> interface IEnumerable end
Members| All Members | Methods | Properties | |||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
Assign(Record) |
Updates or inserts a Record into the View.
|
|
|
Close()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
Columns |
Gets the set of columns that were included in the query for this View,
or null if this view is not a SELECT query.
|
|
|
CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
|
|
Database |
Gets the Database on which this View was opened.
|
|
|
Delete(Record) |
Deletes a Record from the View.
|
|
|
Dispose()()()() |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
Dispose(Boolean) |
Closes the handle. After closing a handle, further method calls may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
Equals(Object) |
Tests whether this handle object is equal to another handle object. Two handle objects are equal
if their types are the same and their native integer handles are the same.
(Inherited from InstallerHandle.) |
|
|
Execute(Record) |
Executes a SQL View query and supplies any required parameters. The query uses the
question mark token to represent parameters as described in SQL Syntax. The values of
these parameters are passed in as the corresponding fields of a parameter record.
|
|
|
Execute()()()() |
Executes a SQL View query.
|
|
|
Fetch()()()() |
Fetches the next sequential record from the view, or null if there are no more records.
|
|
|
Finalize()()()() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetEnumerator()()()() |
Enumerates over the Records retrieved by the View.
|
|
|
GetHashCode()()()() |
Gets a hash value for the handle object.
(Inherited from InstallerHandle.) |
|
|
GetLifetimeService()()()() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
|
|
Handle |
Gets the native integer handle.
(Inherited from InstallerHandle.) |
|
|
InitializeLifetimeService()()()() | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
|
|
Insert(Record) |
Inserts a Record into the view.
|
|
|
InsertTemporary(Record) |
Inserts a Record into the View. The inserted data is not persistent.
|
|
|
IsClosed |
Checks if the handle is closed. When closed, method calls on the handle object may throw an InvalidHandleException.
(Inherited from InstallerHandle.) |
|
|
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
|
|
MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
Merge(Record) |
Inserts or validates a record.
|
|
|
Modify(ViewModifyMode, Record) |
Updates a fetched Record.
|
|
|
QueryString |
Gets the SQL query string used to open this View.
|
|
|
Refresh(Record) |
Refreshes the data in a Record.
|
|
|
Replace(Record) |
Updates or deletes and inserts a Record into the View.
|
|
|
Seek(Record) |
Refreshes the information in the supplied record without changing the position
in the result set and without affecting subsequent fetch operations.
|
|
|
Tables |
Gets the set of tables that were included in the SQL query for this View.
|
|
|
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
|
|
Update(Record) |
Updates the View with new data from the Record.
|
|
|
Validate(Record) |
Validates a record, returning information about any errors.
|
|
|
ValidateDelete(Record) |
Validates a record that will be deleted later, returning information about any errors.
|
|
|
ValidateFields(Record) |
Validates fields of a fetched or new record, returning information about any errors.
Can validate one or more fields of an incomplete record.
|
|
|
ValidateNew(Record) |
Validates a new record, returning information about any errors.
|
Inheritance Hierarchy
Assembly: Microsoft.Deployment.WindowsInstaller (Module: Microsoft.Deployment.WindowsInstaller.dll) Version: 3.0.0.0 (3.11.1.2318)