Share via

NCryptEnumKeys 함수(ncrypt.h)

  • 아티클

NCryptEnumKeys 함수는 공급자가 저장한 키의 이름을 가져옵니다.

구문

SECURITY_STATUS NCryptEnumKeys(
  [in]           NCRYPT_PROV_HANDLE hProvider,
  [in, optional] LPCWSTR            pszScope,
  [out]          NCryptKeyName      **ppKeyName,
  [in, out]      PVOID              *ppEnumState,
  [in]           DWORD              dwFlags
);

매개 변수

[in] hProvider

키를 열거할 키 스토리지 공급자의 핸들입니다. 이 핸들은 NCryptOpenStorageProvider 함수를 사용하여 가져옵니다.

[in, optional] pszScope

이 매개 변수는 현재 사용되지 않으며 NULL이어야 합니다.

[out] ppKeyName

검색된 키의 이름을 수신하는 NCryptKeyName 구조체에 대한 포인터의 주소입니다. 애플리케이션이 이 메모리 사용을 완료하면 NCryptFreeBuffer 함수를 호출하여 해제합니다.

[in, out] ppEnumState

이 함수에 대한 후속 호출에 사용되는 열거형 상태 정보를 수신하는 VOID 포인터의 주소입니다. 이 정보는 키 스토리지 공급자에만 의미가 있으며 호출자에게는 불투명합니다. 키 스토리지 공급자는 이 정보를 사용하여 열거형의 다음 항목을 결정합니다. 이 매개 변수가 가리키는 변수에 NULL이 포함된 경우 열거형은 처음부터 시작됩니다.

이 메모리가 더 이상 필요하지 않은 경우 이 포인터를 NCryptFreeBuffer 함수에 전달하여 해제해야 합니다.

[in] dwFlags

함수 동작을 수정하는 플래그입니다. 이 값은 0이거나 다음 값 중 하나 이상의 조합일 수 있습니다.

값 의미
NCRYPT_MACHINE_KEY_FLAG
 로컬 컴퓨터의 키를 열거합니다. 이 플래그가 없으면 현재 사용자 키가 열거됩니다.
NCRYPT_SILENT_FLAG
 KSP(키 서비스 공급자)가 사용자 인터페이스를 표시하지 않도록 요청합니다. 공급자가 작동할 UI를 표시해야 하는 경우 호출이 실패하고 KSP가 NTE_SILENT_CONTEXT 오류 코드를 마지막 오류로 설정해야 합니다.

반환 값

함수의 성공 또는 실패를 나타내는 상태 코드를 반환합니다.

가능한 반환 코드에는 다음이 포함되지만 이에 국한되지는 않습니다.

반환 코드 설명
ERROR_SUCCESS
 함수가 성공했습니다.
NTE_BAD_FLAGS
 dwFlags 매개 변수에는 유효하지 않은 값이 포함되어 있습니다.
NTE_INVALID_HANDLE
 hProvider 매개 변수가 잘못되었습니다.
NTE_INVALID_PARAMETER
 하나 이상의 매개 변수가 유효하지 않습니다.
NTE_NO_MEMORY
 메모리 할당 오류가 발생했습니다.
NTE_NO_MORE_ITEMS
 열거형의 끝에 도달했습니다.
NTE_SILENT_CONTEXT
 dwFlags 매개 변수에는 NCRYPT_SILENT_FLAG 플래그가 포함되어 있지만 열거되는 키에는 사용자 상호 작용이 필요합니다.

설명

이 함수는 호출할 때마다 하나의 항목만 검색합니다. 열거형의 상태는 ppEnumState 매개 변수가 가리키는 변수에 저장되므로 이 함수에 대한 호출 간에 유지되어야 합니다. 공급자가 저장한 마지막 키를 검색하면 이 함수는 다음에 호출될 때 NTE_NO_MORE_ITEMS 반환합니다. 열거형을 다시 시작하려면 ppEnumState 매개 변수가 가리키는 변수를 NULL로 설정하고, NULL이 아닌 경우ppKeyName 매개 변수가 가리키는 메모리를 해제하고, 이 함수를 다시 호출합니다.

서비스에서 StartService 함수에서 이 함수를 호출해서는 안됩니다. 서비스에서 StartService 함수에서 이 함수를 호출하면 교착 상태가 발생할 수 있으며 서비스가 응답을 중지할 수 있습니다.

요구 사항

요구 사항 값
지원되는 최소 클라이언트 Windows Vista [데스크톱 앱 | UWP 앱]
지원되는 최소 서버 Windows Server 2008 [데스크톱 앱 | UWP 앱]
대상 플랫폼 Windows
헤더 ncrypt.h
라이브러리 Ncrypt.lib
DLL Ncrypt.dll