IRawParameter Interface#

Interface class for raw parameter access.

Syntax#

C#

public interface IRawParameter : IParameter

VB

Public Interface IRawParameter
    Inherits IParameter

The IRawParameter type exposes the following members.

Properties#

	Name	Description
	Advanced	The advanced parameter settings, if available. (Inherited from IParameter.)
	FullName	The full name of the parameter including path information. (Inherited from IParameter.)
	IsEmpty	Indicates if the parameter is empty. If true, the parameter is invalid or does not exist. If a requested parameter does not exist in a parameter collection, an empty parameter object will be returned to simplify handling. An empty parameter is never readable or writable. (Inherited from IParameter.)
	IsReadable	Indicates if the parameter is readable. (Inherited from IParameter.)
	IsWritable	Indicates if the parameter is writable. (Inherited from IParameter.)
	Name	The name of the parameter without path information. (Inherited from IParameter.)

Methods#

	Name	Description
	ParseAndSetValue	Parses the value as string and sets the value. (Inherited from IParameter.)
	ReadRaw(Int64, IntPtr, Int64)	Reads raw data from the specified address into the buffer passed.
	ReadRaw(T)(Int64, T[], Int32, Int32)	Reads raw data from the specified address into the array passed.
	ToString	The parameter value as a string. (Inherited from IParameter.)
	WriteRaw(Int64, IntPtr, Int64)	Writes raw data from the buffer passed to the specified address.
	WriteRaw(T)(Int64, T[], Int32, Int32)	Writes raw data from the array passed to the specified address.

Events#

	Name	Description
	ParameterChanged	This event fires after any of the parameter properties (value, readability, writability, or advanced parameter settings) have changed. (Inherited from IParameter.)
	ParameterValueChanged	This event fires after the parameter value has changed. (Inherited from IParameter.)

IRawParameter.ReadRaw Method (Int64, IntPtr, Int64)#

Reads raw data from the specified address into the buffer passed.

Syntax#

C#

void ReadRaw(
    long address,
    IntPtr pBuffer,
    long bufferSize
)

VB

Sub ReadRaw ( 
    address As Long,
    pBuffer As IntPtr,
    bufferSize As Long
)

Parameters#

address: Type: System.Int64
Starting address to read bufferSize number of bytes from.
pBuffer: Type: System.IntPtr
The memory pointer to store the data read.
bufferSize: Type: System.Int64
The number of bytes to read.

Remarks#

Some cameras may not report a failure if an error occurs and return 0 data instead.

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions if reading fails or if the pointer is invalid.

IRawParameter.ReadRaw(T) Method (Int64, T[], Int32, Int32)#

Reads raw data from the specified address into the array passed.

Syntax#

C#

void ReadRaw<T>(
    long address,
    ref T[] buffer,
    int startIndex,
    int length
)

VB

Sub ReadRaw(Of T) ( 
    address As Long,
    ByRef buffer As T(),
    startIndex As Integer,
    length As Integer
)

Parameters#

address: Type: System.Int64
Starting address to read bufferSize number of bytes from.
buffer: Type: T[]
The one-dimensional array to store the data read.
startIndex: Type: System.Int32
The zero-based index in the destination array where the data will be stored.
length: Type: System.Int32
The number of array elements to store in the array.

Type Parameters#

T: The value type of the one-dimensional array to store the read data.

Remarks#

Some cameras may not report a failure if an error occurs and return 0 data instead.

The number of bytes read is determined by the length parameter and the size of an element in the array.

Preconditions:

The array must be one-dimensional and elements must be of simple types.

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions if reading fails or if the array is not initialized.

IRawParameter.WriteRaw Method (Int64, IntPtr, Int64)#

Writes raw data from the buffer passed to the specified address.

Syntax#

C#

void WriteRaw(
    long address,
    IntPtr pBuffer,
    long bufferSize
)

VB

Sub WriteRaw ( 
    address As Long,
    pBuffer As IntPtr,
    bufferSize As Long
)

Parameters#

address: Type: System.Int64
Starting address to write bufferSize number of bytes to.
pBuffer: Type: System.IntPtr
The memory pointer to read the data from.
bufferSize: Type: System.Int64
The number of bytes to read from the buffer and write to the address.

Remarks#

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions if writing fails or if the pointer is invalid.

IRawParameter.WriteRaw(T) Method (Int64, T[], Int32, Int32)#

Writes raw data from the array passed to the specified address.

Syntax#

C#

void WriteRaw<T>(
    long address,
    T[] buffer,
    int startIndex,
    int length
)

VB

Sub WriteRaw(Of T) ( 
    address As Long,
    buffer As T(),
    startIndex As Integer,
    length As Integer
)

Parameters#

address: Type: System.Int64
Starting address to write bufferSize number of bytes to.
buffer: Type: T[]
The one-dimensional array containing the data to store.
startIndex: Type: System.Int32
The zero-based index in the array where writing data starts.
length: Type: System.Int32
The number of array elements to write.

Type Parameters#

T: The value type of the one-dimensional array containing the data to store.

Remarks#

The number of bytes written is determined by the length parameter and the size of an element in the array.

Preconditions:

The array must be one-dimensional and elements must be of simple types.

Thread Safety: This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions if writing fails or if the array is not initialized

IRawParameter.ReadRaw Method#

Overload List#

	Name	Description
	ReadRaw(Int64, IntPtr, Int64)	Reads raw data from the specified address into the buffer passed.
	ReadRaw(T)(Int64, T[], Int32, Int32)	Reads raw data from the specified address into the array passed.

IRawParameter.WriteRaw Method#

Overload List#

	Name	Description
	WriteRaw(Int64, IntPtr, Int64)	Writes raw data from the buffer passed to the specified address.
	WriteRaw(T)(Int64, T[], Int32, Int32)	Writes raw data from the array passed to the specified address.