CRegKey::QueryDWORDValue

 

Call this method to retrieve the DWORD data for a specified value name.

Syntax

      LONG QueryDWORDValue(
   LPCTSTR pszValueName,
   DWORD& dwValue 
) throw( );

Parameters

  • pszValueName
    Pointer to a null-terminated string containing the name of the value to query.

  • dwValue
    Pointer to a buffer that receives the DWORD.

Return Value

If the method succeeds, ERROR_SUCCESS is returned. If the method fails to read a value, it returns a nonzero error code defined in WINERROR.H. If the data referenced is not of type REG_DWORD, ERROR_INVALID_DATA is returned.

Remarks

This method makes use of RegQueryValueEx and confirms that the correct type of data is returned. See RegQueryValueEx for more details.

System_CAPS_security Security Note

This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the RegQueryValueEx function used by this method does not explicitly handle strings which are NULL terminated. Both conditions should be checked for by the calling code.

Requirements

Header: atlbase.h

See Also

CRegKey Class
CRegKey::SetDWORDValue
CRegKey::QueryBinaryValue
CRegKey::QueryGUIDValue
CRegKey::QueryMultiStringValue
CRegKey::QueryQWORDValue
CRegKey::QueryStringValue