WdfPdoInitAddDeviceText 함수(wdfpdo.h)
[KMDF에만 적용]
WdfPdoInitAddDeviceText 메서드는 지정된 로캘에 대한 디바이스 설명 및 디바이스 위치를 디바이스에 추가합니다.
구문
NTSTATUS WdfPdoInitAddDeviceText(
[in] PWDFDEVICE_INIT DeviceInit,
[in] PCUNICODE_STRING DeviceDescription,
[in] PCUNICODE_STRING DeviceLocation,
[in] LCID LocaleId
);
매개 변수
[in] DeviceInit
WDFDEVICE_INIT 구조체에 대한 포인터입니다.
[in] DeviceDescription
지정된 로캘에 대한 형식이 지정된 디바이스 설명이 포함된 UNICODE_STRING 구조체에 대한 포인터입니다. 드라이버는 페이징 풀에서 문자열의 버퍼를 할당할 수 있습니다.
[in] DeviceLocation
부모 디바이스에서 자식이 발견된 버스의 위치에 대한 설명을 포함하는 UNICODE_STRING 구조체에 대한 포인터입니다. 드라이버는 페이징 풀에서 문자열의 버퍼를 할당할 수 있습니다.
[in] LocaleId
유니코드 문자열의 로캘을 나타내는 LCID(로캘 식별자)입니다. 자세한 내용은 로캘 식별자를 참조하세요.
반환 값
작업이 성공하면 메서드는 STATUS_SUCCESS 반환합니다. 추가 반환 값은 다음과 같습니다.
| 반환 코드 | 설명 |
|---|---|
|
드라이버는 PDO 대신 FDO를 초기화합니다. |
|
드라이버에서 문자열을 저장할 공간을 할당할 수 없습니다. |
메서드는 다른 NTSTATUS 값을 반환할 수도 있습니다.
설명
프레임워크는 지정된 디바이스 텍스트를 저장하고 IRP_MN_QUERY_DEVICE_TEXT 요청에 대한 응답으로 PnP 관리자에게 전달합니다. 사용자가 제공하는 텍스트는 사용자가 디바이스를 식별하는 데 도움이 됩니다. PnP 관리자는 디바이스에 대한 추가 드라이버를 설치하는 동안 텍스트를 표시하는 경우가 있습니다.
WdfPdoInitAddDeviceText를 여러 번 호출하여 여러 로캘에 대한 디바이스 텍스트를 추가할 수 있습니다. 시스템에서 텍스트를 표시하면 사용 가능한 경우 현재 로캘과 일치하는 텍스트를 선택합니다. 그렇지 않으면 기본 로캘에 문자열을 사용합니다. 드라이버는 WdfPdoInitSetDefaultLocale을 호출하여 드라이버의 기본 로캘을 지정할 수 있습니다.
드라이버는 WdfDeviceCreate를 호출하기 전에 WdfPdoInitAddDeviceText를 호출해야 합니다. WdfDeviceCreate를 호출하는 방법에 대한 자세한 내용은 프레임워크 디바이스 개체 만들기를 참조하세요.
예제
다음 코드 예제에서는 디바이스의 위치 및 설명에 대한 유니코드 문자열을 제공합니다. 설명에는 instance 번호가 포함됩니다. WdfPdoInitAddDeviceText를 사용하는 전체 예제는 KbFiltr 샘플 드라이버를 참조하세요.
DECLARE_CONST_UNICODE_STRING(deviceLocation,L"Keyboard Filter\0" );
DECLARE_UNICODE_STRING_SIZE(buffer, MAX_ID_LEN);
status = RtlUnicodeStringPrintf(
&buffer,
L"Keyboard_Filter_%02d",
InstanceNo
);
if (!NT_SUCCESS(status)) {
goto Cleanup;
}
status = WdfPdoInitAddDeviceText(
pDeviceInit,
&buffer,
&deviceLocation,
0x409
);
if (!NT_SUCCESS(status)) {
goto Cleanup;
}
요구 사항
| 요구 사항 | 값 |
|---|---|
| 대상 플랫폼 | 유니버설 |
| 최소 KMDF 버전 | 1.0 |
| 머리글 | wdfpdo.h(Wdf.h 포함) |
| 라이브러리 | Wdf01000.sys(프레임워크 라이브러리 버전 관리 참조) |
| IRQL | PASSIVE_LEVEL |
| DDI 규정 준수 규칙 | ChildDeviceInitAPI(kmdf), DriverCreate(kmdf), InitFreeDeviceCallback(kmdf), InitFreeDeviceCreate(kmdf), InitFreeNull(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), PdoDeviceInitAPI(kmdf), PdoInitFreeDeviceCallback(kmdf), PdoInitFreeDeviceCreate(kmdf) |