SpbTargetGetConnectionParameters function (spbcx.h)
The SpbTargetGetConnectionParameters method retrieves the connection parameters for a target device on the bus.
Syntax
void SpbTargetGetConnectionParameters(
[in] SPBTARGET Target,
[out] SPB_CONNECTION_PARAMETERS *ConnectionParameters
);
Parameters
[in] Target
An SPBTARGET handle to the target device for which to retrieve the connection parameters.
[out] ConnectionParameters
A pointer to a caller-allocated SPB_CONNECTION_PARAMETERS structure into which the method writes the connection parameters. The caller must previously have called the SPB_CONNECTION_PARAMETERS_INIT function to initialize this structure.
Return value
None
Remarks
This method retrieves a set of connection parameters that the SPB controller driver requires to access the specified target device on the bus. For more information, see SPB_CONNECTION_PARAMETERS.
A client (peripheral driver) that successfully opens a connection to a target has exclusive use of that target.
The SPB framework extension (SpbCx) calls your controller driver's EvtSpbTargetConnect and EvtSpbTargetDisconnect callback functions to open and close a connection.
SpbTargetGetConnectionParameters will not fail if it is called with a valid SPBTARGET handle.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Available starting with Windows 8. |
Target Platform | Universal |
Header | spbcx.h |
Library | Spbcxstubs.lib |
IRQL | <= DISPATCH_LEVEL |