dotnet-api-docs/xml/System.Resources/ResourceManager.xml at main · dotnet/dotnet-api-docs

History

1830 lines (1750 loc) · 143 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

</TypeForwardingChain>

<Base>

<BaseTypeName>System.Object</BaseTypeName>

</Base>

<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Serializable]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>

</Attribute>

</Attributes>

<Docs>

<summary>Represents a resource manager that provides convenient access to culture-specific resources at run time.</summary>

<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-resources-resourcemanager">Supplemental API remarks for ResourceManager</see>.</remarks>

<threadsafe>This type is thread safe.</threadsafe>

<related type="Article" href="/dotnet/framework/resources/">Resources in Applications</related>

</Docs>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Resources.ResourceManager" /> class.</summary>

</Docs>

</MemberGroup>

<MemberType>Constructor</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Initializes a new instance of the <see cref="T:System.Resources.ResourceManager" /> class with default values.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

This constructor is useful only if you write your own class that derives from the <xref:System.Resources.ResourceManager> class.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Resources.ResourceManager : Type -> System.Resources.ResourceManager" Usage="new System.Resources.ResourceManager resourceSource" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

</Parameters>

<Docs>

<param name="resourceSource">A type from which the resource manager derives all information for finding .resources files.</param>

<summary>Initializes a new instance of the <see cref="T:System.Resources.ResourceManager" /> class that looks up resources in satellite assemblies based on information from the specified type object.</summary>

<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-resources-resourcemanager-ctor">Supplemental API remarks for ResourceManager constructor</see>.</remarks>

<exception cref="T:System.ArgumentNullException">The <paramref name="resourceSource" /> parameter is <see langword="null" />.</exception>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Resources.ResourceManager : string * System.Reflection.Assembly -> System.Resources.ResourceManager" Usage="new System.Resources.ResourceManager (baseName, assembly)" />

<MemberType>Constructor</MemberType>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

</Parameters>

<Docs>

<param name="baseName">The root name of the resource file without its extension but including any fully qualified namespace name. For example, the root name for the resource file named MyApplication.MyResource.en-US.resources is MyApplication.MyResource.</param>

<param name="assembly">The main assembly for the resources.</param>

<summary>Initializes a new instance of the <see cref="T:System.Resources.ResourceManager" /> class that looks up resources contained in files with the specified root name in the given assembly.</summary>

<exception cref="T:System.ArgumentNullException">The <paramref name="baseName" /> or <paramref name="assembly" /> parameter is <see langword="null" />.</exception>

<para>This constructor uses the system-provided <see cref="T:System.Resources.ResourceSet" /> implementation. To use a custom resource file format, you should derive from the <see cref="T:System.Resources.ResourceSet" /> class, override the <see cref="M:System.Resources.ResourceSet.GetDefaultReader" /> and <see cref="M:System.Resources.ResourceSet.GetDefaultWriter" /> methods, and pass that type to the <see cref="M:System.Resources.ResourceManager.#ctor(System.String,System.Reflection.Assembly,System.Type)" /> constructor. Using a custom <see cref="T:System.Resources.ResourceSet" /> can be useful for controlling resource caching policy or supporting your own resource file format, but is generally not necessary.</para>

</block>

</Docs>

</Member>

<MemberSignature Language="F#" Value="new System.Resources.ResourceManager : string * System.Reflection.Assembly * Type -> System.Resources.ResourceManager" Usage="new System.Resources.ResourceManager (baseName, assembly, usingResourceSet)" />

<MemberType>Constructor</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]</AttributeName>

</Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="assembly">The main assembly for the resources.</param>

<param name="usingResourceSet">The type of the custom <see cref="T:System.Resources.ResourceSet" /> to use. If <see langword="null" />, the default runtime <see cref="T:System.Resources.ResourceSet" /> object is used.</param>

<summary>Initializes a new instance of the <see cref="T:System.Resources.ResourceManager" /> class that uses a specified <see cref="T:System.Resources.ResourceSet" /> class to look up resources contained in files with the specified root name in the given assembly.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The individual culture-specific resource files should be contained in satellite assemblies, and the default culture's resource file should be contained in the main assembly. A satellite assembly is assumed to contain resources for a single culture specified in that assembly's manifest, and is loaded as necessary.

> [!NOTE]

> To retrieve resources from .resources files directly instead of retrieving them from assemblies, you must call the <xref:System.Resources.ResourceManager.CreateFileBasedResourceManager*> method instead to instantiate a <xref:System.Resources.ResourceManager> object.

If the resource file identified by `baseName` cannot be found in `assembly`, the method instantiates a <xref:System.Resources.ResourceManager> object, but the attempt to retrieve a specific resource throws an exception, typically <xref:System.Resources.MissingManifestResourceException>. For information about diagnosing the cause of the exception, see the "Handling the MissingManifestResourceException Exception" section of the <xref:System.Resources.ResourceManager> class topic.

> [!NOTE]

> The `usingResourceSet` parameter is used to support your own resource format, and will commonly be `null`. This is different from the constructor that takes a <xref:System.Type> only.

]]></format>

</remarks>

<paramref name="usingResourceSet" /> is not a derived class of <see cref="T:System.Resources.ResourceSet" />.</exception>

<exception cref="T:System.ArgumentNullException">The <paramref name="baseName" /> or <paramref name="assembly" /> parameter is <see langword="null" />.</exception>

<para>This constructor lets you specify a <see cref="T:System.Resources.ResourceSet" /> implementation. If you do not want a specific <see cref="T:System.Resources.ResourceSet" /> implementation but would like to use a custom resource file format, you should derive from the <see cref="T:System.Resources.ResourceSet" /> class, override the <see cref="M:System.Resources.ResourceSet.GetDefaultReader" /> and <see cref="M:System.Resources.ResourceSet.GetDefaultWriter" /> methods, and pass that type to this constructor.</para>

</block>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets the root name of the resource files that the <see cref="T:System.Resources.ResourceManager" /> searches for resources.</summary>

<value>The root name of the resource files that the <see cref="T:System.Resources.ResourceManager" /> searches for resources.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Resources.ResourceManager.BaseName> property reflects the fully qualified namespace name and the root resource name of a resource file, without its culture or file name extension. For example, if an app's default resource file is named `SampleApps.StringResources.resources`, the value of the <xref:System.Resources.ResourceManager.BaseName> property is "SampleApps.StringResources". If an app's default resource file is named `SampleApps.StringResources.en-US.resources` and is embedded in a satellite assembly, the value of the <xref:System.Resources.ResourceManager.BaseName> property is still "SampleApps.StringResources".

> [!IMPORTANT]

> The <xref:System.Resources.ResourceManager.BaseName> property value of a resource file that is compiled and embedded from the command line does not include a namespace name unless you explicitly include one when compiling the file. On the other hand, the <xref:System.Resources.ResourceManager.BaseName> property value of a resource file that is compiled and embedded within the Visual Studio environment typically does include the default namespace name.

The <xref:System.Resources.ResourceManager.BaseName> property value is the same as the string passed to the <xref:System.Resources.ResourceManager.%23ctor(System.String,System.Reflection.Assembly)> or <xref:System.Resources.ResourceManager.%23ctor(System.String,System.Reflection.Assembly,System.Type)> constructor when instantiating a <xref:System.Resources.ResourceManager> instance.

## Examples

You can determine the names of embedded .resources files by compiling and running the following utility. This is a console app that accepts the name of a main assembly or satellite assembly as a command-line parameter. It displays the strings that should be provided as the `baseName` parameter of the <xref:System.Resources.ResourceManager.%23ctor(System.String,System.Reflection.Assembly)> or <xref:System.Resources.ResourceManager.%23ctor(System.String,System.Reflection.Assembly,System.Type)> constructor so that the resource manager can correctly identify the resource.

:::code language="csharp" source="~/snippets/csharp/System.Resources/MissingManifestResourceException/Overview/resourcenames.cs" id="Snippet4":::

:::code language="vb" source="~/snippets/visualbasic/System.Resources/ResourceManager/BaseName/resourcenames.vb" id="Snippet4":::

]]></format>

</remarks>

</Docs>

</Member>

<MemberType>Field</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

<Docs>

<summary>Specifies the root name of the resource files that the <see cref="T:System.Resources.ResourceManager" /> searches for resources.</summary>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Resources.ResourceManager.BaseNameField> field is useful only if you write your own class that derives from the <xref:System.Resources.ResourceManager> class.

]]></format>

</remarks>

</Docs>

</Member>

<MemberSignature Language="F#" Value="static member CreateFileBasedResourceManager : string * string * Type -> System.Resources.ResourceManager" Usage="System.Resources.ResourceManager.CreateFileBasedResourceManager (baseName, resourceDir, usingResourceSet)" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Resources.ResourceManager</ReturnType>

</ReturnValue>

</Attribute>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="baseName">The root name of the resources. For example, the root name for the resource file named "MyResource.en-US.resources" is "MyResource".</param>

<param name="resourceDir">The name of the directory to search for the resources. <paramref name="resourceDir" /> can be an absolute path or a relative path from the application directory.</param>

<summary>Returns a <see cref="T:System.Resources.ResourceManager" /> object that searches a specific directory instead of an assembly manifest for resources.</summary>

<returns>A new instance of a resource manager that searches the specified directory instead of an assembly manifest for resources.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

This method returns a resource manager that retrieves resources from a .resources file that is not embedded in an assembly. You can use this <xref:System.Resources.ResourceManager> object to load resources for an ASP.NET page or to test a <xref:System.Resources.ResourceSet> implementation. For an example that retrieves resources from a standalone .resources file, see the [Retrieving Resources](/dotnet/framework/resources/retrieving-resources-in-desktop-apps) article.

This method lets you specify a <xref:System.Resources.ResourceSet> implementation. If you do not want a specific <xref:System.Resources.ResourceSet> implementation, but would like to use a custom resource file format, you should derive from the <xref:System.Resources.ResourceSet> class, override the <xref:System.Resources.ResourceSet.GetDefaultReader*> and <xref:System.Resources.ResourceSet.GetDefaultWriter*> methods, and pass that type to this constructor.

> [!CAUTION]

> Using standalone .resources files in an ASP.NET app will break XCOPY deployment, because the resources remain locked until they are explicitly released by the <xref:System.Resources.ResourceManager.ReleaseAllResources*> method. If you want to deploy resources with your ASP.NET apps, compile your .resources files into satellite assemblies.

]]></format>

</remarks>

<exception cref="T:System.ArgumentNullException">The <paramref name="baseName" /> or <paramref name="resourceDir" /> parameter is <see langword="null" />.</exception>

</Docs>

</Member>

<MemberType>Property</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Resources.UltimateResourceFallbackLocation</ReturnType>

</ReturnValue>

<Docs>

<summary>Gets or sets the location from which to retrieve default fallback resources.</summary>

<value>One of the enumeration values that specifies where the resource manager can look for fallback resources.</value>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Resources.ResourceManager.FallbackLocation> property is useful only if you write your own class that derives from the <xref:System.Resources.ResourceManager> class.

You can use the <xref:System.Resources.NeutralResourcesLanguageAttribute> attribute to inform the resource manager where to find the default culture for an app: in the main assembly (default) or in a satellite assembly.

]]></format>

</remarks>

<related type="Article" href="/dotnet/framework/resources/packaging-and-deploying-resources-in-desktop-apps">Packaging and Deploying Resources</related>

</Docs>

</Member>

<MemberSignature Language="F#" Value="static member GetNeutralResourcesLanguage : System.Reflection.Assembly -> System.Globalization.CultureInfo" Usage="System.Resources.ResourceManager.GetNeutralResourcesLanguage a" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Globalization.CultureInfo</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="a">The assembly for which to return culture-specific information.</param>

<summary>Returns culture-specific information for the main assembly's default resources by retrieving the value of the <see cref="T:System.Resources.NeutralResourcesLanguageAttribute" /> attribute on a specified assembly.</summary>

<returns>The culture from the <see cref="T:System.Resources.NeutralResourcesLanguageAttribute" /> attribute, if found; otherwise, the invariant culture.</returns>

<remarks>To be added.</remarks>

</Docs>

</Member>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<Docs>

<summary>Returns the value of the specified non-string resource for the current culture.</summary>

</Docs>

</MemberGroup>

<MemberSignature Language="F#" Value="abstract member GetObject : string -> obj
override this.GetObject : string -> obj" Usage="resourceManager.GetObject name" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Object</ReturnType>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</ReturnValue>

</Parameters>

<Docs>

<param name="name">The name of the resource to get.</param>

<summary>Returns the value of the specified non-string resource.</summary>

<returns>The value of the resource localized for the caller's current culture settings. If an appropriate resource set exists but <paramref name="name" /> cannot be found, the method returns <see langword="null" />.</returns>

<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-resources-resourcemanager-getobject">Supplemental API remarks for ResourceManager.GetObject</see>.</remarks>

<exception cref="T:System.ArgumentNullException">The <paramref name="name" /> parameter is <see langword="null" />.</exception>

<exception cref="T:System.Resources.MissingManifestResourceException">No usable set of localized resources has been found, and there are no default culture resources. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the <see cref="T:System.Resources.ResourceManager" /> class topic.</exception>

<exception cref="T:System.Resources.MissingSatelliteAssemblyException">The default culture's resources reside in a satellite assembly that could not be found. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the <see cref="T:System.Resources.ResourceManager" /> class topic.</exception>

<related type="Article" href="/dotnet/framework/resources/packaging-and-deploying-resources-in-desktop-apps">Packaging and Deploying Resources</related>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member GetObject : string * System.Globalization.CultureInfo -> obj
override this.GetObject : string * System.Globalization.CultureInfo -> obj" Usage="resourceManager.GetObject (name, culture)" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.Object</ReturnType>

</ReturnValue>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>

</Attribute>

</Attributes>

</Parameter>

</Parameters>

<Docs>

<param name="name">The name of the resource to get.</param>

<param name="culture">The culture for which the resource is localized. If the resource is not localized for this culture, the resource manager uses fallback rules to locate an appropriate resource.

If this value is <see langword="null" />, the <see cref="T:System.Globalization.CultureInfo" /> object is obtained by using the <see cref="P:System.Globalization.CultureInfo.CurrentUICulture" /> property.</param>

<summary>Gets the value of the specified non-string resource localized for the specified culture.</summary>

<returns>The value of the resource, localized for the specified culture. If an appropriate resource set exists but <paramref name="name" /> cannot be found, the method returns <see langword="null" />.</returns>

<exception cref="T:System.ArgumentNullException">The <paramref name="name" /> parameter is <see langword="null" />.</exception>

<exception cref="T:System.Resources.MissingManifestResourceException">No usable set of resources have been found, and there are no default culture resources. For information about how to handle this exception, see the "Handling MissingManifestResourceException and MissingSatelliteAssemblyException Exceptions" section in the <see cref="T:System.Resources.ResourceManager" /> class topic.</exception>

<threadsafe>The <see cref="M:System.Resources.ResourceManager.GetObject(System.String,System.Globalization.CultureInfo)" /> method is thread safe.</threadsafe>

<related type="Article" href="/dotnet/framework/resources/packaging-and-deploying-resources-in-desktop-apps">Packaging and Deploying Resources</related>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member GetResourceFileName : System.Globalization.CultureInfo -> string
override this.GetResourceFileName : System.Globalization.CultureInfo -> string" Usage="resourceManager.GetResourceFileName culture" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<ReturnType>System.String</ReturnType>

</ReturnValue>

</Parameters>

<Docs>

<param name="culture">The culture object for which a resource file name is constructed.</param>

<summary>Generates the name of the resource file for the given <see cref="T:System.Globalization.CultureInfo" /> object.</summary>

<returns>The name that can be used for a resource file for the given <see cref="T:System.Globalization.CultureInfo" /> object.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The <xref:System.Resources.ResourceManager.GetResourceFileName*> method is useful only if you write your own class that derives from the <xref:System.Resources.ResourceManager> class.

This method uses the <xref:System.Globalization.CultureInfo.Name?displayProperty=nameWithType> property as part of the file name for all cultures other than the invariant culture. This method does not look in an assembly's manifest or touch the disk, and is used only to construct a resource file name (suitable for passing to the <xref:System.Resources.ResourceReader> constructor) or a manifest resource blob name.

A derived class can override this method to look for a different extension, such as ".ResX", or a completely different scheme for naming resource files. Note that the method can be used to customize the name of a resource file within a satellite assembly, and not to customize the name of the satellite assembly itself.

]]></format>

</remarks>

<related type="Article" href="/dotnet/standard/globalization-localization/">Globalizing and localizing .NET applications</related>

</Docs>

</Member>

<MemberSignature Language="F#" Value="abstract member GetResourceSet : System.Globalization.CultureInfo * bool * bool -> System.Resources.ResourceSet
override this.GetResourceSet : System.Globalization.CultureInfo * bool * bool -> System.Resources.ResourceSet" Usage="resourceManager.GetResourceSet (culture, createIfNotExists, tryParents)" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

</AssemblyInfo>

<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>

</Attribute>

</Attributes>

<ReturnType>System.Resources.ResourceSet</ReturnType>

<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>

</Attribute>

</Attributes>

</ReturnValue>

</Parameters>

<Docs>

<param name="culture">The culture whose resources are to be retrieved.</param>

<see langword="true" /> to load the resource set, if it has not been loaded yet; otherwise, <see langword="false" />.</param>

<see langword="true" /> to use resource fallback to load an appropriate resource if the resource set cannot be found; <see langword="false" /> to bypass the resource fallback process.</param>

<summary>Retrieves the resource set for a particular culture.</summary>

<returns>The resource set for the specified culture.</returns>

<format type="text/markdown"><![CDATA[

## Remarks

The resource set that is returned represents the resources that are localized for the specified culture. If the resources have not been localized for that culture and `tryParents` is `true`, <xref:System.Resources.ResourceManager.GetResourceSet*> uses resource fallback rules to load an appropriate resource. If `tryParents` is `false` and a culture-specific resource set cannot be found, the method returns `null`. For more information about resource fallback, see "The Resource Fallback Process" section in the [Packaging and Deploying Resources](/dotnet/framework/resources/packaging-and-deploying-resources-in-desktop-apps) article.

## Examples

The following example calls the <xref:System.Resources.ResourceManager.GetResourceSet*> method to retrieve culture-specific resources for the French (France) culture. It then enumerates all of the resources in the resource set. It contains the source code for an executable named ShowNumbers.exe. The example includes two text files that contain the names of numbers. The first, NumberResources.txt, contains the names of numbers from one to ten in the English language:

```txt

one=one

two=two

three=three

four=four

five=five

six=six

seven=seven

eight=eight

nine=nine

ten=ten

```

The second, NumberResources.fr-FR.txt, contains the names of numbers from one to four in the French language:

```txt

one=un

two=deux

three=trois

four=quatre

```

You can use a batch file to generate the resource files, embed the English language resource file into the executable, and create a satellite assembly for the French language resources. Here's the batch file to generate an executable by using the Visual Basic compiler:

```bat

resgen NumberResources.txt

vbc shownumbers.vb /resource:NumberResources.resources

md fr-FR

resgen NumberResources.fr-FR.txt

al /out:fr-FR\ShowNumbers.resources.dll /culture:fr-FR /embed:NumberResources.fr-FR.resources

```

For the C# compiler, you can use the following batch file:

```bat

resgen NumberResources.txt

csc shownumbers.cs /resource:NumberResources.resources

md fr-FR

resgen NumberResources.fr-FR.txt

al /out:fr-FR\ShowNumbers.resources.dll /culture:fr-FR /embed:NumberResources.fr-FR.resources

```

:::code language="csharp" source="~/snippets/csharp/System.Resources/ResourceManager/GetResourceSet/shownumbers.cs" id="Snippet1":::

:::code language="vb" source="~/snippets/visualbasic/System.Resources/ResourceManager/GetResourceSet/shownumbers.vb" id="Snippet1":::

If you change the value of the `createIfNotExists` argument to `false`, the method call returns `null`, since Resource Manager hasn't yet loaded the French language resources.

]]></format>

</remarks>

<exception cref="T:System.ArgumentNullException">The <paramref name="culture" /> parameter is <see langword="null" />.</exception>

<paramref name="tryParents" /> is <see langword="true" />, no usable set of resources has been found, and there are no default culture resources.</exception>

<related type="Article" href="/dotnet/standard/globalization-localization/">Globalizing and localizing .NET applications</related>

</Docs>

</Member>

<MemberSignature Language="F#" Value="static member GetSatelliteContractVersion : System.Reflection.Assembly -> Version" Usage="System.Resources.ResourceManager.GetSatelliteContractVersion a" />

<MemberType>Method</MemberType>

<AssemblyName>mscorlib</AssemblyName>

</AssemblyInfo>

<AssemblyName>netstandard</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Resources.ResourceManager</AssemblyName>

</AssemblyInfo>

<AssemblyName>System.Runtime</AssemblyName>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

ResourceManager.xml

Latest commit

History

ResourceManager.xml

File metadata and controls