SEARCH   
Home About Us Products Manufacturing Services Support ARK online Contact Us
Support > Software Downloads >
ARK® Tutorial



Introduction  |  Core Component  |  Communications  |  Additional Topics  |  Reference Guide




 
   

Reference Guide

interface IRequest

Request objects contain data that are used with PARAGON-based products. They are managed entirely by controller components and product components and do not need to be manipulated by fitting software.

Definition
interface IRequest : IDispatch
{
[propget]
HRESULT Address([out, retval] long* rval);
[propget]
HRESULT SubAddress([out, retval] long* rval);
[propget]
HRESULT AbsoluteAddress([out, retval] VARIANT_BOOL* rval);
HRESULT GetData([in] long max, [out, size_is(max), length_is(*actual)] unsigned char* data, [out] long* actual);
HRESULT SetData([in] long n, [in, size_is(n)] unsigned char* data);
HRESULT GetDataSafe([in] long max, [out] SAFEARRAY(unsigned char)* data);
HRESULT SetDataSafe([in] SAFEARRAY(unsigned char)* data, [in, defaultvalue(-1)] long n);
HRESULT Copy([out, retval] IRequest** rval);
};

Descriptions

[propget]
HRESULT Address([out, retval] long* rval);
The address that the request refers to.

[propget]
HRESULT SubAddress([out, retval] long* rval);
The sub-address that the request refers to.

[propget]
HRESULT AbsoluteAddress([out, retval] VARIANT_BOOL* rval);
Indicates whether the address and subaddress are independent of the memory number.

HRESULT GetData([in] long max, [out, size_is(max), length_is(*actual)] unsigned char* data, [out] long* actual);
Gets the array of data bytes. This method is intended for use with C and C++.

HRESULT SetData([in] long n, [in, size_is(n)] unsigned char* data);
Sets the array of data bytes. This method is intended for use with C and C++.

HRESULT GetDataSafe([in] long max, [out] SAFEARRAY(unsigned char)* data);
Gets the array of data bytes. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.

HRESULT SetDataSafe([in] SAFEARRAY(unsigned char)* data, [in, defaultvalue(-1)] long n);
Sets the array of data bytes. This method is intended for use with Visual Basic, Matlab, and other development environments that implement arrays as SAFEARRAY structures.

HRESULT Copy([out, retval] IRequest** rval);
Makes a copy of the Request object.




© ON Semiconductor  |   PRIVACY POLICY  |   TERMS OF USE