[Networking] GetIpAddrTable function (iphlpapi.h)

GetIpAddrTable 함수는 로컬 컴퓨터의 IP 주소 테이블을 검색하는 Windows API 함수다. 이 테이블에는 시스템의 각 네트워크 인터페이스와 연결된 IP 주소 목록이 포함되어 있다. 이 함수에는 테이블을 수신할 버퍼에 대한 포인터, 버퍼 크기를 지정하는 변수에 대한 포인터, 테이블 정렬 여부를 나타내는 boolean 값의 세가지 매개변수가 필요하다. 이 함수는 성공 또는 실패를 나타내는 상태 코드를 반환하며, 버퍼는 IP 주소 테이블을 저장할 수 있는 올바른 크기로 할당돼야 한다.

 

DWORD GetIpAddrTable(
    _Out_writes_bytes_opt_(*pdwSize) PMIB_IPADDRTABLE pIpAddrTable,
    _Inout_ PULONG pdwSize,
    _In_ BOOL bOrder
);

 

1. 매개변수
   1. pIpAddrTable (OUT parameter)
      1. 타입: PMIB_IPADDRTABLE
      2. 설명
         : IP 주소 테이블을 MIB_IPADDRTABLE 구조체로 수신하는 버퍼에 대한 포인터다. 이 구조체에는 각각 IP 주소와 관련 정보를 나타내는 MIB_IPADDROW 구조체 배열이 포함되어 있다.
      3. _Out_writes_bytes_opt_(*pdwSize)
         : 이 주석은 버퍼가 선택 사항이며 pdwSize로 지정된 크기로 할당되어야 함을 나타낸다.
   2. pdwSize (INOUT parameter)
      
      1. 타입: PULONG
      2. 설명
         : 입력 시, 이 매개변수는 pIpAddrTable이 가리키는 버퍼의 크기를 지정한다. 출력 시 버퍼가 너무 작으면 필요한 크기의 버퍼를 받는다. 제공된 버퍼가 너무 작으면 이 함수는 ERROR_INSUFFICIENT_BUFFER를 반환한다.
      3. _Inout_
         : 이 주석은 이 매개변수가 입력 및 출력 매개변수임을 나타낸다.
   3. bOrder (IN parameter)
      
      1. 타입: BOOL
      2. 설명
         : 반환된 IP 주소 테이블을 IP 주소별로 오름차순으로 정렬할지 여부를 지정하는 boolean 값이다. 이 매개변수가 TRUE면 테이블이 정렬되고, FALSE면 테이블이 정렬되지 않는다. 
2. 반환 값
   : 이 함수는 함수 호출의 상태를 나타내는 DWORD 값을 반환한다. 가능한 반환 값은 다음과 같다.
   
   1. NO_ERROR
      : 함수가 성공했다
   2. ERROR_INSUFFICIENT_BUFFER
      : pIpAddrTable이 가리키는 버퍼가 너무 작아 반환된 데이터를 담을 수 없다. 필요한 버퍼 크기는 pdwSize가 가리키는 변수에 반환된다.
   3. 기타 에러 코드는 Windows API 문서에 정의된 대로 반환된다.
3. 사용 예시
   : 아래 예시는 IP address table을 검색하는 'GetIpAddrTable' 사용 예시다.

#include <iostream>
#include <Windows.h>
#include <iphlpapi.h>

#pragma comment(lib, "IPHLPAPI.lib")

int main() {
    // Initial buffer size
    ULONG bufferSize = 0;
    
    // Call to determine the required buffer size
    GetIpAddrTable(nullptr, &bufferSize, FALSE);
    
    // Allocate the required buffer
    PMIB_IPADDRTABLE pIpAddrTable = (PMIB_IPADDRTABLE)malloc(bufferSize);
    
    // Call to get the actual IP address table
    DWORD result = GetIpAddrTable(pIpAddrTable, &bufferSize, FALSE);
    
    if (result == NO_ERROR) {
        // Print the IP addresses
        for (DWORD i = 0; i < pIpAddrTable->dwNumEntries; ++i) {
            IN_ADDR ipAddr;
            ipAddr.S_un.S_addr = pIpAddrTable->table[i].dwAddr;
            std::cout << "IP Address: " << inet_ntoa(ipAddr) << std::endl;
        }
    } else {
        std::cerr << "GetIpAddrTable failed with error: " << result << std::endl;
    }

    // Clean up
    free(pIpAddrTable);
    return 0;
}

 

• 버퍼 크기 결정
  : 처음에는 pIpAddrTable에 대해 nullptr을 사용해 GetIpAddrTable을 호출해 필요한 버퍼 크기를 결정한다. 필요한 크기는 bufferSize로 반환된다.
• 버퍼 할당
  : pIpAddrTable에 필요한 크기의 버퍼 할당
• IP 주소 테이블 검색
  : 할당된 버퍼를 사용해 GetIpAddrTable을 다시 호출한다. 이 함수는 버퍼를 IP 주소 테이블로 채운다.
• IP 주소 테이블 처리
  : MIB_IPADDRTABLE 구조체의 항복을 반복해 각 IP 주소에 액세스하고 이를 프린트한다.
• 정리
  : 메모리 누수를 방지하기 위해 pIpAddrTable에 할당된 메모리를 해제한다. 

 

참고

- https://learn.microsoft.com/en-us/windows/win32/api/iphlpapi/nf-iphlpapi-getipaddrtable