Skip to content

Commit

Permalink
Merge branch 'master' of vs-ssh.visualstudio.com:v3/cpubwin/win32/sdk…
Browse files Browse the repository at this point in the history 
…-api into docs
  • Loading branch information
@cxwtool
cxwtool committed Jan 30, 2020
2 parents 8f13fff + 6116ff0 commit ce4a7dc
Show file tree
Hide file tree
Showing 18 changed files with 94 additions and 456 deletions.
33 changes: 3 additions & 30 deletions sdk-api-src/content/davclnt/nc-davclnt-pfndavauthcallback.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,32 +43,22 @@ req.redist:
ms.custom: 19H1
---

# PFNDAVAUTHCALLBACK callback function


## -description


The WebDAV client calls the application-defined <i>DavAuthCallback</i> callback function to prompt the user for credentials.

The <i>PFNDAVAUTHCALLBACK</i> type defines a pointer to this callback function. <i>DavAuthCallback</i> is a placeholder for the application-defined function name.


## -parameters




### -param lpwzServerName [in]

A pointer to a <b>NULL</b>-terminated Unicode string that contains the name of the target server.


### -param lpwzRemoteName [in]

A pointer to a <b>NULL</b>-terminated Unicode string that contains the name of the network resource.


### -param dwAuthScheme [in]

A bitmask of flags that specify the authentication schemes to be used.
Expand Down Expand Up @@ -160,8 +150,6 @@ Forms-based authentication is to be used.
</td>
</tr>
</table>



### -param dwFlags [in]

Expand All @@ -173,40 +161,29 @@ The flags that the WebDAV service passed in the <i>dwFlags</i> parameter when it
A pointer to a <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/ns-davclnt-dav_callback_cred">DAV_CALLBACK_CRED</a> structure.


### -param *NextStep [in, out]
### -param NextStep [in, out]

A pointer to an <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/ne-davclnt-authnextstep">AUTHNEXTSTEP</a> enumeration value that specifies the next action that the WebDAV client should take after a successful call to the <i>DavAuthCallback</i> callback function.


### -param *pFreeCred [out]
### -param pFreeCred [out]

A pointer to a <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nc-davclnt-pfndavauthcallback_freecred">DavFreeCredCallback</a> callback function.


## -returns



If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is a <a href="https://docs.microsoft.com/windows/desktop/Debug/system-error-codes">system error code</a>.




## -remarks



The <i>DavAuthCallback</i> callback function must be registered by calling the <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davregisterauthcallback">DavRegisterAuthCallback</a> function.

To unregister this callback function, use the <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davunregisterauthcallback">DavUnregisterAuthCallback</a> function.

This callback function should prompt the user for credentials (either a <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/ns-davclnt-dav_callback_auth_unp">user name and password</a> or an <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/ns-davclnt-dav_callback_auth_blob">authentication BLOB</a>) and store this information in the appropriate member of the <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/ns-davclnt-dav_callback_cred">DAV_CALLBACK_CRED</a> structure that the <i>pCallbackCred</i> parameter points to.




## -see-also


Expand All @@ -228,8 +205,4 @@ This callback function should prompt the user for credentials (either a <a href=



<a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nc-davclnt-pfndavauthcallback_freecred">DavFreeCredCallback</a>




<a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nc-davclnt-pfndavauthcallback_freecred">DavFreeCredCallback</a>
32 changes: 1 addition & 31 deletions sdk-api-src/content/davclnt/nf-davclnt-davunregisterauthcallback.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,50 +43,20 @@ req.redist:
ms.custom: 19H1
---

# DavUnregisterAuthCallback function


## -description


Unregisters a registered callback function that the WebDAV client uses to prompt the user for credentials.


## -parameters




### -param hCallback [in]

The opaque handle that was returned by the <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davregisterauthcallback">DavRegisterAuthCallback</a> function.


## -returns



This function does not return a value.




## -remarks



To register the callback function, use the <a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davregisterauthcallback">DavRegisterAuthCallback</a> function.




## -see-also




<a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davregisterauthcallback">DavRegisterAuthCallback</a>




<a href="https://docs.microsoft.com/windows/desktop/api/davclnt/nf-davclnt-davregisterauthcallback">DavRegisterAuthCallback</a>
30 changes: 1 addition & 29 deletions sdk-api-src/content/drt/nf-drt-drtunregisterkey.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,50 +43,26 @@ req.redist:
ms.custom: 19H1
---

# DrtUnregisterKey function


## -description


The <b>DrtUnregisterKey</b> function deregisters a key from the DRT.


## -parameters




### -param hKeyRegistration [in]

The DRT handle returned by the <a href="https://docs.microsoft.com/windows/desktop/api/drt/nf-drt-drtregisterkey">DrtRegisterKey</a> function specifying a registered key within the DRT.


## -returns



This function does not return a value.




## -remarks



A node can deregister a key anytime after registration. Additionally, if an application calls <a href="https://docs.microsoft.com/windows/desktop/api/drt/nf-drt-drtclose">DrtClose</a>, all keys are deregistered by the DRT infrastructure.

Only the application that registered they key may deregister it. An application can deregister a key from the local node. Upon completion the function triggers a <b>DRT_EVENT_LEAFSET_KEY_CHANGE</b> event; informing the application and other nodes participating in the DRT mesh of the deregistration.




## -see-also




<a href="https://docs.microsoft.com/windows/desktop/api/drt/nf-drt-drtclose">DrtClose</a>


Expand All @@ -95,8 +71,4 @@ Only the application that registered they key may deregister it. An application



<a href="https://docs.microsoft.com/windows/desktop/api/drt/nf-drt-drtregisterkey">DrtRegisterKey</a>




<a href="https://docs.microsoft.com/windows/desktop/api/drt/nf-drt-drtregisterkey">DrtRegisterKey</a>
33 changes: 2 additions & 31 deletions sdk-api-src/content/dxgi1_3/nf-dxgi1_3-idxgidevice3-trim.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,9 @@ req.redist:
ms.custom: 19H1
---

# IDXGIDevice3::Trim


## -description


Trims the graphics memory allocated by the <a href="https://docs.microsoft.com/windows/desktop/api/dxgi1_3/nn-dxgi1_3-idxgidevice3">IDXGIDevice3</a>
DXGI device on the app's behalf.
Trims the graphics memory allocated by the <a href="https://docs.microsoft.com/windows/desktop/api/dxgi1_3/nn-dxgi1_3-idxgidevice3">IDXGIDevice3</a> DXGI device on the app's behalf.

For apps that render with DirectX, graphics drivers periodically allocate internal memory buffers in order to speed up subsequent rendering requests. These memory allocations count against the app's memory usage for PLM and in general lead to increased memory usage by the overall system.

Expand All @@ -66,30 +61,6 @@ Similar to <a href="https://docs.microsoft.com/windows/desktop/api/d3d11/nf-d3d1
It is also prudent to release references on middleware before calling <b>Trim</b>, as that middleware may also need to release references
to Direct3D objects.


## -parameters






## -returns



This method does not return a value.




## -see-also




<a href="https://docs.microsoft.com/windows/desktop/api/dxgi1_3/nn-dxgi1_3-idxgidevice3">IDXGIDevice3</a>




<a href="https://docs.microsoft.com/windows/desktop/api/dxgi1_3/nn-dxgi1_3-idxgidevice3">IDXGIDevice3</a>
14 changes: 3 additions & 11 deletions ...gdiplusbrush-hatchbrush-hatchbrush(inhatchstyle_inconstcolor__inconstcolor_).md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,35 +44,27 @@ req.product: GDI+ 1.0
ms.custom: 19H1
---

# HatchBrush::HatchBrush(IN HatchStyle,IN const Color &,IN const Color &)


## -description


Creates a <b>HatchBrush::HatchBrush</b> object based on a hatch style, a foreground color, and a background color.


## -parameters




#### - hatchStyle [in]
### -param hatchStyle [in]

Type: <b><a href="https://docs.microsoft.com/windows/desktop/api/gdiplusenums/ne-gdiplusenums-hatchstyle">HatchStyle</a></b>

Element of the <a href="https://docs.microsoft.com/windows/desktop/api/gdiplusenums/ne-gdiplusenums-hatchstyle">HatchStyle</a> enumeration that specifies the pattern of hatch lines that will be used.


#### - foreColor [in, ref]
### -param foreColor [in, ref]

Type: <b>const <a href="https://docs.microsoft.com/windows/desktop/api/gdipluscolor/nl-gdipluscolor-color">Color</a></b>

Reference to a color to use for the hatch lines.


#### - backColor [in, ref]
### -param backColor [in, ref]

Type: <b>const <a href="https://docs.microsoft.com/windows/desktop/api/gdipluscolor/nl-gdipluscolor-color">Color</a></b>

Expand Down
Loading

0 comments on commit ce4a7dc

Please sign in to comment.