CryptEnumOIDInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function enumerates predefined and registered object identifier CRYPT_OID_INFO structures. This function enumerates either all of the predefined and registered structures or only structures identified by a selected object identifier (OID) group. For each OID information structure enumerated, an application-provided callback function, pfnEnumOIDInfo, is called.

Syntax

BOOL WINAPI CryptEnumOIDInfo(
  DWORD dwGroupId,
  DWORD dwFlags,
  void* pvArg,
  PFN_CRYPT_ENUM_OID_INFO pfnEnumOIDInfo
);

Parameters

• dwGroupId
  [in] Specifies the OID groups to be matched. Setting the dwGroupId parameter to zero matches all groups. If dwGroupId is greater than zero, only the OID entries in the specified group are enumerated.

  The following OID group identifiers are currently defined:

  None

  CRYPT_HASH_ALG_OID_GROUP_ID

  CRYPT_ENCRYPT_ALG_OID_GROUP_ID

  CRYPT_PUBKEY_ALG_OID_GROUP_ID

  CRYPT_SIGN_ALG_OID_GROUP_ID

  CRYPT_RDN_ATTR_OID_GROUP_ID

  CRYPT_EXT_OR_ATTR_OID_GROUP_ID

  CRYPT_ENHKEY_USAGE_OID_GROUP_ID

  CRYPT_POLICY_OID_GROUP_ID

  CRYPT_TEMPLATE_OID_GROUP_ID

• dwFlags
  [in] Reserved for future use and must be set to zero.

• pvArg
  [in] Pointer to arguments to be passed through to the callback function.

• pfnEnumOIDInfo
  [in] Pointer to the callback function that is executed for each OID information entry enumerated.

Return Value

The function returns FALSE when the function has stopped the enumeration.

Remarks

The following example shows the signature for the callback function pointed to by the pfnEnumOIDInfo parameter. The callback function is typically used to print out the contents of each OID entry enumerated.

BOOL (WINAPI *PFN_CRYPT_ENUM_OID_INFO)(
  PCCRYPT_OID_INFO pInfo,
  void* pvArg
); 

In this code, pvInfo is a pointer to the OID information and pvArg is a pointer to arguments passed through to the callback function.

Requirements

See Also

Reference

CRYPT_OID_INFO