EOS_SessionSearch_CopySearchResultByIndex

EOS API reference page for EOS_SessionSearch_CopySearchResultByIndex

Choose your implementation method:

C

C#

This function is part of the Sessions Interface.

Remarks

EOS_SessionSearch_CopySearchResultByIndex is used to immediately retrieve a handle to the session information from a given search result. If the call returns an EOS_Success result, the out parameter, OutSessionHandle, must be passed to EOS_SessionDetails_Release to release the memory associated with it.

Return Value

  • EOS_Success if the information is available and passed out in OutSessionHandle

  • EOS_InvalidParameters if you pass an invalid index or a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

See Also

EOS_SessionSearch_CopySearchResultByIndexOptions, EOS_SessionDetails_Release

Parameters

EOS_SessionSearch_CopySearchResultByIndex

Parameter Type And Name

Usage Information

EOS_HSessionSearch Handle

const EOS_SessionSearch_CopySearchResultByIndexOptions* Options

Structure containing the input parameters

EOS_HSessionDetails* OutSessionHandle

out parameter used to receive the session handle

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members

This function is part of the Sessions Interface.

Remarks

{CopySearchResultByIndex} is used to immediately retrieve a handle to the session information from a given search result. If the call returns an {Result.Success} result, the out parameter, OutSessionHandle, must be passed to {SessionDetails.Release} to release the memory associated with it. {Result.InvalidParameters} if you pass an invalid index or a null pointer for the out parameter {Result.IncompatibleVersion} if the API version passed in is incorrect

Return Value

{Result.Success} if the information is available and passed out in OutSessionHandle

See Also

{SessionSearchCopySearchResultByIndexOptions}, {SessionDetails.Release}

Parameters

Sessions.SessionSearch.CopySearchResultByIndex

Parameter Type And Name

Usage Information

SessionSearchCopySearchResultByIndexOptions options

Structure containing the input parameters

SessionDetails outSessionHandle

out parameter used to receive the session handle

If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members