Redundant Host API

Arguments:

 

Handle –

the handle of the current session

pInstanceID –

pointer to the character buffer where the RH Instance ID associated with

 

the given handle is stored as a null-terminated character string

InstanceIDLength

the size of the buffer; if this size is too small for the output, this function

 

fails.

pActualSize -

this variable receives the actual size of the returned Instance ID; in the

 

case of the error code HSI_STATUS_INSUFFICIENT_BUFFER

 

returned, this is the minimal required size of the buffer.

Return Value:

 

HSI_STATUS_SUCCESS

returned in the case of success

HSI_STATUS_INVALID_PARAMETER invalid session handle

HSI_STATUS_INSUFFICIENT_BUFFER

returned if the buffer pInstanceID is too small to store the RH Instance

ID

HSI_STATUS_NOT_SUPPORTED

returned if this function is not supported by the infrastructure

Other, implementation-defined HSI_STATUS values

returned if other errors occurred during execution of this function

Synopsis:

This function returns the RH Instance ID for the given session handle. This is a character string that identifies the specific RH system with which the application communicates via the RH API in the specified session. The format of this string is implementation-dependent.

If multiple RH infrastructures are present on the current host, an intermediate layer of functionality between the application and infrastructures may be defined, that implements this function. If this is the case, that intermediate layer should ensure that the value returned to the application can be used to get access to the same RH System via RhOpen (for example, the intermediate layer may prepend the string returned to the application by the textual identifier of the infrastructure).

6.2.3Domain and Host Information API

6.2.3.1RhGetDomainCount

Prototype:

HSI_STATUS

RhGetDomainCount(

IN RH_HANDLE Handle,

OUT uint32 *pCount );

Arguments:

High Availability Software for the Intel® NetStructureTM ZT 4901 Technical Product Specification

45

Page 45
Image 45
Intel ZT 4901 manual Domain and Host Information API, RhGetDomainCount, Handle Handle of the current session PInstanceID