Skip to content

Commit 2d785da

Browse files
craigcaseyMSFTcraigcaseyMSFT
committed
updates after review
1 parent eee4ffb commit 2d785da

File tree

4 files changed

+141
-141
lines changed

4 files changed

+141
-141
lines changed

‎docs/atl/reference/cregkey-class.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class CRegKey
8383
When you close a key, its registry data is written (flushed) to the hard disk. This process may take several seconds. If your application must explicitly write registry data to the hard disk, you can call the [`RegFlushKey`](/windows/win32/api/winreg/nf-winreg-regflushkey) Win32 function. However, `RegFlushKey` uses many system resources and should be called only when absolutely necessary.
8484

8585
> [!IMPORTANT]
86-
> Any methods that allow the caller to specify a registry location have the potential to read data that cannot be trusted. Methods that make use of [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) should take into consideration that this function does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
86+
> Any methods that allow the caller to specify a registry location have the potential to read data that cannot be trusted. Methods that make use of [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) should take into consideration that this function does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
8787
8888
## Requirements
8989

@@ -469,7 +469,7 @@ LONG QueryBinaryValue(
469469
### Parameters
470470
471471
*`pszValueName`*\
472-
Pointer to a null-terminated string containing the name of the value to query.
472+
Pointer to a `NULL` terminated string containing the name of the value to query.
473473
474474
*`pValue`*\
475475
Pointer to a buffer that receives the value's data.
@@ -486,7 +486,7 @@ If the method succeeds, `ERROR_SUCCESS` is returned. If the method fails to read
486486
This method makes use of `RegQueryValueEx` and confirms that the correct type of data is returned. See [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) for more details.
487487
488488
> [!IMPORTANT]
489-
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
489+
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
490490
491491
## <a name="querydwordvalue"></a> `CRegKey::QueryDWORDValue`
492492
@@ -501,7 +501,7 @@ LONG QueryDWORDValue(
501501
### Parameters
502502
503503
*`pszValueName`*\
504-
Pointer to a null-terminated string containing the name of the value to query.
504+
Pointer to a `NULL` terminated string containing the name of the value to query.
505505
506506
*`dwValue`*\
507507
Pointer to a buffer that receives the `DWORD`.
@@ -515,7 +515,7 @@ If the method succeeds, `ERROR_SUCCESS` is returned. If the method fails to read
515515
This method makes use of `RegQueryValueEx` and confirms that the correct type of data is returned. See [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) for more details.
516516
517517
> [!IMPORTANT]
518-
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
518+
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
519519
520520
## <a name="queryguidvalue"></a> `CRegKey::QueryGUIDValue`
521521
@@ -530,7 +530,7 @@ LONG QueryGUIDValue(
530530
### Parameters
531531
532532
*`pszValueName`*\
533-
Pointer to a null-terminated string containing the name of the value to query.
533+
Pointer to a `NULL` terminated string containing the name of the value to query.
534534
535535
*`guidValue`*\
536536
Pointer to a variable that receives the GUID.
@@ -560,10 +560,10 @@ LONG QueryMultiStringValue(
560560
### Parameters
561561
562562
*`pszValueName`*\
563-
Pointer to a null-terminated string containing the name of the value to query.
563+
Pointer to a `NULL` terminated string containing the name of the value to query.
564564
565565
*`pszValue`*\
566-
Pointer to a buffer that receives the multistring data. A multistring is an array of null-terminated strings, terminated by two null characters.
566+
Pointer to a buffer that receives the multistring data. A multistring is an array of `NULL` terminated strings, terminated by two null characters.
567567
568568
*`pnChars`*\
569569
The size, in `TCHARs`, of the buffer pointed to by *`pszValue`*. When the method returns, *`pnChars`* contains the size, in `TCHARs`, of the multistring retrieved, including a terminating null character.
@@ -577,7 +577,7 @@ If the method succeeds, `ERROR_SUCCESS` is returned. If the method fails to read
577577
This method makes use of `RegQueryValueEx` and confirms that the correct type of data is returned. See [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) for more details.
578578
579579
> [!IMPORTANT]
580-
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
580+
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
581581
582582
## <a name="queryqwordvalue"></a> `CRegKey::QueryQWORDValue`
583583
@@ -592,7 +592,7 @@ LONG QueryQWORDValue(
592592
### Parameters
593593
594594
*`pszValueName`*\
595-
Pointer to a null-terminated string containing the name of the value to query.
595+
Pointer to a `NULL` terminated string containing the name of the value to query.
596596
597597
*`qwValue`*\
598598
Pointer to a buffer that receives the `QWORD`.
@@ -606,7 +606,7 @@ If the method succeeds, `ERROR_SUCCESS` is returned. If the method fails to read
606606
This method makes use of `RegQueryValueEx` and confirms that the correct type of data is returned. See [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) for more details.
607607
608608
> [!IMPORTANT]
609-
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
609+
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
610610
611611
## <a name="querystringvalue"></a> `CRegKey::QueryStringValue`
612612
@@ -622,7 +622,7 @@ LONG QueryStringValue(
622622
### Parameters
623623
624624
*`pszValueName`*\
625-
Pointer to a null-terminated string containing the name of the value to query.
625+
Pointer to a `NULL` terminated string containing the name of the value to query.
626626
627627
*`pszValue`*\
628628
Pointer to a buffer that receives the string data.
@@ -639,7 +639,7 @@ If the method succeeds, `ERROR_SUCCESS` is returned. If the method fails to read
639639
This method makes use of `RegQueryValueEx` and confirms that the correct type of data is returned. See [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) for more details.
640640
641641
> [!IMPORTANT]
642-
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are null-terminated. Both conditions should be checked for by the calling code.
642+
> This method allows the caller to specify any registry location, potentially reading data which cannot be trusted. Also, the [`RegQueryValueEx`](/windows/win32/api/winreg/nf-winreg-regqueryvalueexw) function used by this method does not explicitly handle strings which are `NULL` terminated. Both conditions should be checked for by the calling code.
643643
644644
## <a name="queryvalue"></a> `CRegKey::QueryValue`
645645
@@ -665,7 +665,7 @@ ATL_DEPRECATED LONG QueryValue(
665665
### Parameters
666666
667667
*`pszValueName`*\
668-
Pointer to a null-terminated string containing the name of the value to query. If *`pszValueName`* is `NULL` or an empty string, "", the method retrieves the type and data for the key's unnamed or default value, if any.
668+
Pointer to a `NULL` terminated string containing the name of the value to query. If *`pszValueName`* is `NULL` or an empty string, "", the method retrieves the type and data for the key's unnamed or default value, if any.
669669
670670
*`pdwType`*\
671671
Pointer to a variable that receives a code indicating the type of data stored in the specified value. The *`pdwType`* parameter can be `NULL` if the type code isn't required.
@@ -699,7 +699,7 @@ The two original versions of `QueryValue` are no longer supported and are marked
699699
The remaining method calls `RegQueryValueEx`.
700700
701701
> [!IMPORTANT]
702-
> 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.
702+
> 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.
703703
704704
## <a name="recursedeletekey"></a> `CRegKey::RecurseDeleteKey`
705705
@@ -774,7 +774,7 @@ If the method succeeds, the return value is `ERROR_SUCCESS`. If the method fails
774774
775775
### Remarks
776776
777-
This method uses [RegSetValueEx](/windows/win32/api/winreg/nf-winreg-regsetvalueexw) to write the value to the registry.
777+
This method uses [`RegSetValueEx`](/windows/win32/api/winreg/nf-winreg-regsetvalueexw) to write the value to the registry.
778778
779779
## <a name="setguidvalue"></a> `CRegKey::SetGUIDValue`
780780
@@ -875,7 +875,7 @@ LONG SetMultiStringValue(LPCTSTR pszValueName, LPCTSTR pszValue) throw();
875875
Pointer to a string containing the name of the value to set. If a value with this name isn't already present, the method adds it to the key.
876876
877877
*`pszValue`*\
878-
Pointer to the multistring data to be stored with the specified value name. A multistring is an array of null-terminated strings, terminated by two null characters.
878+
Pointer to the multistring data to be stored with the specified value name. A multistring is an array of `NULL` terminated strings, terminated by two null characters.
879879
880880
### Return Value
881881

‎docs/mfc/reference/coblist-class.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ The following table shows other member functions that are similar to `CObList::F
236236

237237
|Class|Member Function|
238238
|-----------|---------------------|
239-
|[`CPtrList`](../../mfc/reference/cptrlist-class.md)|`POSITION Find( void * searchValue , POSITION startAfter = NULL ) const;`|
239+
|[`CPtrList`](../../mfc/reference/cptrlist-class.md)|`POSITION Find( void *searchValue , POSITION startAfter = NULL ) const;`|
240240
|[`CStringList`](../../mfc/reference/cstringlist-class.md)|`POSITION Find( LPCTSTR searchValue , POSITION startAfter = NULL ) const;`|
241241

242242
### Example

0 commit comments

Comments
 (0)