| CARVIEW |
Select Language
HTTP/2 200
date: Sat, 19 Jul 2025 01:02:56 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
etag: W/"6442dbc986e1ce0612a94c999a672039"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=RjP8seYKVzhYjvWS31uJLqobq2EkHUWue03XEHz3gfHc%2BPmyynmRhlq2DEa7OcaoRMg%2FFxJeVAhFra7AhYWV74uwoH%2B%2B%2BTfs%2FRpXAbW3Fcf%2FDjUxItwMkWvSEnaHGSK5zYPUWd%2FZvrmkkBiKNhbGzkiAbsg4k1Mpiwsvc3Z8L%2F0olSSpjS%2F00eUooGtDpw1peWvo1lJrUmFByTADMOgOPQ277VGyVlWQnev1CuH5boJVcfyNdgF2aHJjCR6uc7%2FUodHBatJHNQpSxuMR671png%3D%3D--HLivruUxxICJ2VKH--DyVhCslsPF3OatryrveRkQ%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1424045629.1752886976; Path=/; Domain=github.com; Expires=Sun, 19 Jul 2026 01:02:56 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Sun, 19 Jul 2026 01:02:56 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: C892:2DAD44:261F20:34EB19:687AEEC0
Returns: Methods · dotnet/dotnet-api-docs Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Returns: Methods
Genevieve Warren edited this page Oct 3, 2023
·
4 revisions
The following table shows the boilerplate wording for return value descriptions within method topics. The wording varies according to the type that's returned.
| Return type | Wording | Examples |
|---|---|---|
| Task<T> or ValueTask<T> | A task object that, when awaited, produces <XXX>. |
Type: Task<String> A task object that, when awaited, produces the response body. |
| Class, interface, or structure | <Noun phrase description without specifying the data type. Begin with an introductory article.> Note: If the abstraction is not clear from the context, you can use the wording "An object that identifies/specifies/contains XXX." However, avoid this unless there is no other way to describe the return value. |
Type: System.Threading.Thread The new thread. Type: System.IAsyncResult The posted asynchronous request. |
| Flag enum | A bitwise combination of the enumeration values <additional information, if necessary>. | Type: System.IO.FileAccess A bitwise combination of the enumeration values. |
| Other enum | One of the enumeration values <additional information, if necessary>. | Type: System.Windows.Forms.DialogResult One of the enumeration values that indicates the return value of a dialog box. |
| Boolean |
true if XXX; otherwise, false. true if XXX; false if XXX. Note: Use the "otherwise" wording unless the second condition must be noted explicitly. Note: The wording for Boolean return values is "true if...," not "true to...." (The wording "true to...." is for parameters.) |
Type: System.Boolean true if the specified path refers to a file; otherwise, false. Type: System.Boolean true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. For ShouldSerialize <Property> methods, use this phrasing: Type:System.Boolean true if the InputBindings property value should be serialized; otherwise, false. |
| Other primitive or string | <Noun phrase description, without specifying the data type. Begin with an introductory article.> | Type: System.String The string being read. Type: System.Int32 The hash code for the current SortDescription object. |
| Array | An array XXX. | Type: System.Reflection.FieldInfo() An array that contains the fields implemented by a type. |
Clone this wiki locally
You can’t perform that action at this time.