Share via

IComponentAuthenticate::SACAuth (deprecated)

  • Article
banner art

This is preliminary documentation and subject to change.

This topic documents a feature of the Windows Media Device Manager SDK. We recommend that you migrate your application to use the Windows Portable Devices API. For more information, see the Windows Portable Devices SDK.

The SACAuth method establishes a secure authenticated channel between components.

Syntax

HRESULT SACAuth(
  DWORD  dwProtocolID,
  DWORD  dwPass,
  BYTE*  pbDataIn,
  DWORD  dwDataInLen,
  BYTE**  ppbDataOut,
  DWORD*  pdwDataOutLen
);

Parameters

dwProtocolID

[in]  DWORD containing the protocol identifier. For this version of Windows Media Device Manager, always set this parameter to SAC_PROTOCOL_V1.

dwPass

[in]  DWORD containing the number of the current communication pass. A pass consists of two messages, one in each direction. SAC_PROTOCOL_V1 is a two-pass protocol, and the passes are numbered 0 and 1.

pbDataIn

[in]  Pointer to the input data.

dwDataInLen

[in]  DWORD containing the length of the data to which pbDataIn points.

ppbDataOut

[out]  Pointer to a pointer to the output data.

pdwDataOutLen

[out]  Pointer to a DWORD containing the length of the data to which ppbDataOut points.

Return Values

The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:

  • Standard COM error codes
  • Windows error codes converted to HRESULT values
  • Windows Media Device Manager error codes

For an extensive list of possible error codes, see Error Codes.

Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
E_INVALIDARG The pbSPSessionKey parameter is invalid or is a NULL pointer.
E_FAIL An unspecified error occurred.

Remarks

This method is called only by service providers. It is called one or more times as dictated by the protocol identifier.

The structure of the data in pbDataIn and ppbDataOut is determined by the values of dwProtocolID and dwPass.

Example Code

The following C++ code demonstrates a service provider's implementation of SACAuth. It calls CSecureChannelServer::SACAuth on a previously created private CSecureChannelServer member.

HRESULT CMyServiceProvider::SACAuth(
    DWORD   dwProtocolID,
    DWORD   dwPass,
    BYTE   *pbDataIn,
    DWORD   dwDataInLen,
    BYTE  **ppbDataOut,
    DWORD  *pdwDataOutLen)
{
    HRESULT hr = S_OK;

    // Verify that the global CSecureChannelServer member is valid.
    if(g_pAppSCServer == NULL)
        return E_FAIL;

    hr = g_pAppSCServer->SACAuth(
        dwProtocolID,
        dwPass,
        pbDataIn, dwDataInLen,
        ppbDataOut, pdwDataOutLen
    );
    return hr;
}

Requirements

Header: Defined in icomponentauthenticate.idl.

Library: mssachlp.lib

See Also