CmGetNextIpAddr (Compact 2013)
3/26/2014
This function gets the next address associated with the specified destination host.
Syntax
CM_RESULT CmGetNextIpAddr(
__in CM_CONNECTION_HANDLE hConnection,
__inout_bcount(*pcbAddressPair) CM_ADDRESS_PAIR* pAddressPair,
__inout DWORD* pcbAddressPair
);
Parameters
- hConnection
[in] A CM_CONNECTION_HANDLE value.
pAddressPair
[in] A pointer to a storage area to place the output.[out] A pointer to a set of CM_ADDRESS_PAIR structures.
pcbAddressPair
[in] A pointer to a storage area to place the output.[out] A pointer to the count of structures in pAddressPair.
Return Value
Value |
Description |
---|---|
CMRE_SUCCESS |
The operation completed successfully. |
CMRE_INVALID_CONNECTION |
The name of the connection is not valid. |
CMRE_HOST_ADDRESS_ITERATION_NOT_STARTED |
Host address iteration has not been started with CmGetFirstIpAddr. |
CMRE_NO_HOST_ADDRESSES |
The host name could not be resolved using the connection. |
CMRE_INSUFFICIENT_BUFFER |
The pAddressPair output buffer is too small to contain the address pair. The required output buffer size is returned in pcbAddressPair. |
CMRE_INVALID_VERSION |
The version of the pAddressPair is not supported. |
CMRE_UNEXPECTED |
An unexpected failure occurred. |
Remarks
When called repetitively, this function iterates through all the addresses.
This function requires that you first call CmGetFirstIpAddr.
Requirements
Header |
cmnet.h |
Library |
cmnet.lib |
See Also
Reference
Connection Manager Connectivity Functions
CM_ADDRESS_PAIR
CM_CONNECTION_HANDLE
CmGetFirstIpAddr